home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / tools / coref.exe / CREF.DOC < prev    next >
Encoding:
Text File  |  1992-08-10  |  19.3 KB  |  454 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                                     CREF
  12.                             Charts of Reference
  13.                                 Version 1.1
  14.                            ──────────────────────
  15.                         Command Line & TSR Versions
  16.                         ────────────────────────────
  17.                        (C)Copyright 1992 Rand Nowell
  18.                              RaLin Enterprises
  19.                         "Putting Bits Together" (tm)
  20.  
  21.                          - Program Documentation -
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.                                 MANUAL INDEX
  31.  
  32.  
  33.  
  34.            LEGAL STUFF..........................................0
  35.            SHAREWARE ?..........................................1
  36.            SYSTEM REQUIREMENTS..................................1
  37.            WHERE TO PUT CREF....................................1
  38.            STARTUP:
  39.                Save Screen......................................1
  40.                No Save Screen...................................1
  41.            TSR VERSION..........................................4
  42.            SELECTING MENU ITEMS.................................2
  43.            HOT KEY SWITCHING....................................2
  44.            THE CHARTS: The Information.
  45.                <K> Keys..Extended Keys..........................2
  46.                <T> Attr..Text Attributes........................2
  47.                <C> Char..Character Codes......................2,3
  48.                <A> Pascal..Color Codes..........................3
  49.                <N> Ansi..Ansi Escape Codes......................3
  50.                <S> Ascii..Ascii Text Color Codes................3
  51.                <Q> Quit..Exiting CREF...........................3
  52.            MACROS: Calling from programs.
  53.                Qedit............................................3
  54.                Boxer..........................................3,4
  55.                Qmodem...........................................4
  56.                Other Programs...................................4
  57.            REGISTRATION.......................................4,5
  58.            SUGGESTIONS..........................................5
  59.            ACKNOWLEDGEMENTS.....................................5
  60.            DEVELOPMENT..........................................5
  61.            SUPPORT..............................................5
  62.  
  63.  
  64.  
  65.    Copyright:
  66.  
  67.    CREF 1.1  is not a Public Domain or Free program. It is the
  68.    Copyrighted (c) 1992 work of Rand Nowell dba Ralin Enterprises.
  69.    All rights are reserved. Copying, duplicating, selling or otherwise
  70.    distributing this product except as noted in the Distribution Policy
  71.    below is a violation of Federal Copyright Law.
  72.  
  73.    You are authorized to evaluate the program for a period of 30 days.
  74.    If after 30 days you wish to continue using the program, a registration
  75.    is in Order. Please see REGCOM.DOC
  76.  
  77.    Distribution:
  78.  
  79.    1. Feel free to distribute the Shareware version of this program as
  80.       often as you like to any interested parties. Distribution to
  81.       Electronic Bullentin Boards is encouraged.
  82.    2. Please do not distribute this program without all the original
  83.       related files such as documentation, readme files, registration
  84.       forms etc.
  85.    3. Please distribute ONLY the original authenticated ZIP format file.
  86.    4. Please obtain our written permission before including the program
  87.       with any "bundled" software packages.
  88.    5. Please do not accept payment for the program; a copying fee of
  89.       $5.00 per diskette may be charged by a non-profit user-group.
  90.    6. Please do not alter the program or documentation in any way.
  91.    7. Individuals, groups, vendors or other software distribution
  92.       companies which market diskettes containg shareware or test-drive
  93.       evaluation programs, for profit, must obtain written permission
  94.       from RaLin Enterprises prior to distribution.
  95.  
  96.     DISTRIBUTION of the REGISTERED version of this program is in
  97.     violation of the license agreement and copyright law.
  98.  
  99.     ************************* DISCLAIMER *****************************
  100.  
  101.     This program is supplied "as is" without warrenty of any kind. The
  102.     entire risk of using, and results from the use of, is assumed by you
  103.     the user.  You assume all costs of repair, servicing and corrections
  104.     stemming from the use of this program.
  105.     Rand Nowell and/or RaLin Enterprises, or any other associated
  106.     company of the program author will not be held liable for any
  107.     damages from the use of this program. No warrenties are expressed or
  108.     implied.
  109.     ********************************************************************
  110.     To the original licensee of the REGISTERD version of CREF 1.0
  111.     RaLin Enterprises DOES warrant that the program disk(s) on which the
  112.     program is recorded, be free from defects in material and
  113.     workmanship under normal use and service for a period of (90) ninety
  114.     days from date of delivery as evidenced by your receipt. Our entire
  115.     liability and your exclusive remedy shall be replacement of the
  116.     deffective disk not meeting the standards of this limited warranty.
  117.  
  118.   
  119. CREF.DOC         Charts Of Reference Manual                    Page   1
  120.  
  121.  SHAREWARE?
  122.  
  123.          What is it ?  A shareware program is one that the author
  124.          distributes for the people to try, free of charge. Usually the
  125.          author will set a time limit on this "Free Trial" and if you
  126.          continue to use the product after this time period, you are usually
  127.          expected to pay a small registration fee. Unlike commercial
  128.          software where you Buy then Try, this allows you to evaluate the
  129.          program without investing your hard earned money, then if you like
  130.          it and find it useful and only then, do you register it. If you do
  131.          not intend to register a shareware program, you should stop using
  132.          it, and delete it from your system. What a deal!
  133.  
  134.  
  135.  SYSTEM REQUIREMENTS:
  136.  
  137.         Memory:       Runs in minimum amount of memory. If calling from
  138.                       within another program then figure on CREF using
  139.                       about another 52k of memory.
  140.  
  141.         Video:        Requires a graphics card and color monitor.
  142.  
  143.         Dos Version:  Will work from 3.0 up, not tested in lower versions
  144.                       but should work with 2.0 + There is no version
  145.                       checking within the program.
  146.  
  147.  WHERE TO PUT IT:
  148.  
  149.         CREF should be stored in a directory that is included in your path
  150.         statement. This is especially true if you are going to be calling it
  151.         from within another program. Placing CREF in a "PATH" directory will
  152.         allow it to be called from anywhere in your system.
  153.  
  154.  STARTUP:
  155.  
  156.       Command syntax: CREF [/s]
  157.  
  158.       CREF alone will call the program without saving the underlying screen,
  159.       the screen is cleared on starting and on completion.
  160.  
  161.       [/s] If you wish to preserve your underlying screen, so that you can
  162.       view it while using CREF, use the switch /s  the 's' MUST be lower
  163.       case, and the switch must have a space between it and CREF.
  164.        The /s switch has no effect when CREF is called from within another
  165.        program, as that program performs a Dos SHELL to run CREF, and should
  166.        save its own screen. (See the MACROS section.)
  167.  
  168.  
  169.        Once CREF has started you will see a Title and Copyright notice at
  170.        the top of the screen, and just below it to the far left will be the
  171.        CREF menu.
  172.  
  173.   Information at your fingertips!
  174.  
  175.  
  176. CREF.DOC         Charts Of Reference Manual                    Page  2
  177.  
  178.  
  179.                    Artery....The study of fine paintings.
  180.  
  181.  SELECTING MENU ITEMS:
  182.  
  183.        There are several ways to select items on the Menu.
  184.        1. Use the up/down arrow keys to highlight your choice,
  185.           then press <Enter>.
  186.  
  187.        2. Press the highlighted letter of a Menu item.
  188.  
  189.        3. Using the arrow keys, move the highlight bar to a selection, then
  190.           press the right or left arrow key.
  191.  
  192.  HOT KEY SWITCHING:
  193.  
  194.        Once you have a chart on the screen, you may put it away by pressing
  195.        ESC. This returns you to the Menu to make another choice or to Exit.
  196.        But it is not necessary to return to the Menu to view another chart,
  197.        when any chart (except the Character charts) is active, you can press
  198.        the HotKey of any Menu choice and replace the current chart with the
  199.        one called. The exception to this HotKey trick is the Character
  200.        Charts...there are three of them, pressing any key other than escape
  201.        will rotate between them, pressing Esc exits back to the Menu. So you
  202.        must return to the Menu to select another chart when viewing the
  203.        Character Charts.
  204.  
  205.      Example:  Suppose you are viewing the P(a)scal chart, pressing the
  206.                letter (n) would immediately display the A(n)si chart.
  207.                * Its a neat trick! *
  208.  
  209.                  Nitrate......different than the day rate.
  210.  
  211.   THE CHARTS:
  212.  
  213.    <K> Keys:  The Keys chart is a full screen display of Extended Key codes,
  214.        these are the codes generated when an Alt/Ctrl/Shft key combination
  215.        is pressed, also the 12 Function keys F1 - F12. When these
  216.        combination keys are pressed there are actually two codes produced,
  217.        the first is always 0 (thats zero) and the second is the decimal code
  218.        listed in this chart. Codes can also be referenced in Hexadecimal,
  219.        but this chart shows only the decimal codes. There is also a short
  220.        example of how to determine if an Extended key code has been
  221.        generated. This example is in Pascal format. Press Esc to put this
  222.        chart away and return to the Menu, or HotKey to another.
  223.  
  224.    <T> Attr:  The Attribute Chart shows the Background/Foreground decimal
  225.        codes. The first digit is the Background color, the second is the
  226.        foreground. These numbers are shown using Decimal and Hex format for
  227.        those situations where you need to use this format.
  228.  
  229.    <C> Char:  This produces a group of 3 screens showing the character
  230.        codes. Some of these would be entered with the Ctrl key, others would
  231.  
  232.   Information at your fingertips!
  233.  
  234.  
  235. CREF.DOC         Charts Of Reference Manual                    Page  3
  236.  
  237.        be entered using the Alt key and the number pad keys. If you were to
  238.        hold down the Alt key and, using the keys on the number key pad, type
  239.        251, it would produce the checkmark (√) such as this. Remember, when
  240.        using the Alt+Number method, the numbers must be entered using the
  241.        key pad to the right of the keyboard. It will not work using the
  242.        number keys at the top of the keyboard.
  243.        Pressing the spacebar will cycle through these 3 screens, pressing
  244.        Esc will exit to the Menu. You cannot HotKey to another chart from
  245.        the Character charts.
  246.  
  247.                           Tumor.....An extra pair.
  248.  
  249.    <A> Pascal:  This displays a chart of color numbers that can be used when
  250.        you need to specify both colors with one number. Using a Pascal
  251.        example again, TextAttr:=95 would produce bright white on magenta.
  252.  
  253.    <N> Ansi:  This chart displays many of the Ansi color codes that are
  254.        useful in assigning color to text in Dos batch files. The proper
  255.        syntax is also shown for such commands.
  256.  
  257.    <S> Ascii:  Here we have the Dos textcolor codes. This chart is somewhat
  258.        similar to the Attr chart above, but the color numbers are all in
  259.        decimal. A Pascal example would be TextBackground(5);TextColor(15)
  260.        would give us bright white on magenta.
  261.  
  262.    <Q> Quit: Last but not least is the Quit option. Exits CREF and returns
  263.        you to the calling program, or Dos. If the /s switch was used, your
  264.        screen will be restored to its startup state.
  265.  
  266.                           Hangnail.....A coathook.
  267.  
  268.  MACROS:
  269.  
  270.         Here a couple of macros for calling CREF from some popular programs.
  271.  
  272.     1. Qedit: Using Qconfig.exe and the qconfig.dat  assign  this macro to
  273.        the available key of your choice....
  274.  
  275.  MacroBegin SaveFile Dos 'CREF' Return Quit EditFile CurrentFileName Return
  276.  
  277.      This macro will save the file you are working on, shell to dos and run
  278.      CREF, then return to Qedit, reload you file, and put you right back
  279.      where you left off. This is the macro I use, and have used it several
  280.      times during the writing of this Manual.
  281.  
  282.      2. Boxer:  You must assign the commands to a macro key, here we are
  283.      assigning it to Ctrl-C, here are the steps.
  284.        a) Press F8
  285.        b) Press F9 (Boxers Dos Call key)
  286.        c) Type CREF
  287.        d) Press Enter
  288.        e) Once the CREF menu is displayed press (Q)uit
  289.        f) Press any key to return to Boxer
  290.        g) Press F8 again
  291.  
  292.   Information at your fingertips!
  293.  
  294.  
  295. CREF.DOC         Charts Of Reference Manual                    Page  4
  296.  
  297.        h) Enter a title for the macro, such as Calls Cref Charts.
  298.        * Thats it...your ready to call CREF from the Boxer Editor any time
  299.        you need it.
  300.  
  301.        3. Qmodem: You probably wouldn't need CREF to often here, but if you
  302.           are writing a script and want to use colors, access the CREF
  303.           Pascal chart for the proper color numbers. Remember to add 128 to
  304.           the color number if you want the foreground color to blink.
  305.  
  306.           NOTE: If you want to be able to call CREF when writing Qmodem
  307.           scripts, you will have to use another editor. Qmodem's editor
  308.           QMEdit won't allow macros, or a Dos shell. Configure the program
  309.           to call another editor such as Qedit.
  310.  
  311.                       Urine.....opposite of "Your Out"
  312.  
  313.           But you can call CREF from the terminal screen, press Alt-J to
  314.           call up the macro editor, choose a key combination to use, then
  315.           enter @shellx CREF and save. Then pressing that key combination
  316.           will shell out and load CREF. This is assuming that CREF can be
  317.           found by the system. (Refer back to Where To Put CREF.)
  318.  
  319.    As for setting up CREF to be called from any other programs, these
  320.    examples should give you an idea on how to set it up. Refer to the
  321.    particular programs documentation on how to set up external program
  322.    calls.
  323.  
  324.    ***********************************************************************
  325.    TSR VERSION: The TSR version has been created! Please refer to the
  326.                 CREFR.DOC for any differences in the program.
  327.    ************************************************************************
  328.  
  329.    REGISTRATION:
  330.  
  331.                 If you find CREF useful to you, and you continue to use it,
  332.                 then you should REGISTER it. This will show me that the
  333.                 program is being well received and induce me to continue its
  334.                 development, such as more charts etc.
  335.  
  336.                            Node.....Was aware of.
  337.  
  338.                 If there appears to be no intrest in the program, ie
  339.                 lack of Registrations, then I will not further its
  340.                 development. Seems fair...eh what!?
  341.  
  342.                 If you send me $10.00 (or more <grin>) I will send you new
  343.                 copies of the programs on disk, you will also receive some
  344.                 more handy utilities from RaLin Enterprises...for FREE.
  345.  
  346.                 A registration form has been provided for anyone that wishes
  347.  
  348.   Information at your fingertips!
  349.  
  350.  
  351. CREF.DOC         Charts Of Reference Manual                    Page  5
  352.  
  353.                 to donate to the cause. <REGCOM.DOC>
  354.                 You will be recorded in our database as a registered user.
  355.                 You will receive notices of new  product releases.
  356.                 You will receive unlimited support for the product.....
  357.                 and anything else I can think of to treat you right!
  358.  
  359.   SUGGESTIONS:
  360.  
  361.           If you have some suggestions, or requests, pertaining to types of
  362.           charts to add to CREF, please use the Suggestion/Comments form
  363.           that is provided. <REGCOM.DOC>
  364.  
  365.           I do hope that CREF helps you in your work!
  366.  
  367.  ACKNOWLEDGEMENTS:
  368.  
  369.           Several products have been mentioned here, now we will pay respect
  370.           to the authors.....
  371.  
  372.   Pascal:  By Borland International...a fantastic programming language.
  373.   Qedit:   By SemWare...one of the BEST editors around.
  374.   Boxer:   By David R. Hamel....an awesome text editor...kudos to Dave!
  375.   Qmodem:  By Mustang Software...the premier Communications package.
  376.   CREF:    By Rand Nowell/RaLin Enterprises....wait a minute here.....
  377.  
  378.   DEVELOPMENT:
  379.  
  380.       CREF was written in Turbo Pascal. Borland International.
  381.  
  382.       Screens and menus generated by Saywhat! Screen Developer from
  383.       Software Science, a fantastic screen developer for multiple
  384.       programming languages and Dos batch files!
  385.  
  386.                       Medical Staff......doctors cane.
  387.  
  388.  
  389.   SUPPORT:
  390.  
  391.        I can be reached at the following:
  392.  
  393.        Phone: 510-651-0253  If I'm out leave a message. I return registered
  394.        users calls at my expense, otherwise it will be collect.
  395.  
  396.        NetMail: 1:/215/777  or  1:161/42   - Rand Nowell
  397.  
  398.        CIS:  76124,761
  399.  
  400.        Mail:  40728 Sundale Dr. Fremont, Ca. 94538
  401.  
  402.        FIDO:  Shareware Echo   - Rand Nowell
  403.  
  404.        Genie: R.Nowell
  405.  
  406.    Information at your fingertips!
  407.  
  408.  
  409.  
  410.          ----------------end-of-author's-documentation---------------
  411.  
  412.                          Software Library Information:
  413.  
  414.                     This disk copy provided as a service of
  415.  
  416.                            Public (software) Library
  417.  
  418.          We are not the authors of this program, nor are we associated
  419.          with the author in any way other than as a distributor of the
  420.          program in accordance with the author's terms of distribution.
  421.  
  422.          Please direct shareware payments and specific questions about
  423.          this program to the author of the program, whose name appears
  424.          elsewhere in  this documentation. If you have trouble getting
  425.          in touch with the author,  we will do whatever we can to help
  426.          you with your questions. All programs have been tested and do
  427.          run.  To report problems,  please use the form that is in the
  428.          file PROBLEM.DOC on many of our disks or in other written for-
  429.          mat with screen printouts, if possible.  PsL cannot debug pro-
  430.          programs over the telephone, though we can answer questions.
  431.  
  432.          Disks in the PsL are updated  monthly,  so if you did not get
  433.          this disk directly from the PsL, you should be aware that the
  434.          files in this set may no longer be the current versions. Also,
  435.          if you got this disk from another vendor and are having prob-
  436.          lems,  be aware that  some files may have become corrupted or
  437.          lost by that vendor. Get a current, working disk from PsL.
  438.  
  439.          For a copy of the latest monthly software library newsletter
  440.          and a list of the 4,000+ disks in the library, call or write
  441.  
  442.                            Public (software) Library
  443.                                P.O.Box 35705 - F
  444.                             Houston, TX 77235-5705
  445.  
  446.                                 1-800-2424-PSL
  447.                              MC/Visa/AmEx/Discover
  448.  
  449.                           Outside of U.S. or in Texas
  450.                           or for general information,
  451.                               Call 1-713-524-6394
  452.  
  453.  
  454.